home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / pascal / zipsorc.com / ZIPSORCE.DOC < prev    next >
Encoding:
Text File  |  1990-07-15  |  9.6 KB  |  232 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                   ZIPSORCE
  7.  
  8.                               Zip Source files
  9.  
  10.                        Copyright (c) 1990, 1991, 1992
  11.                              Transversal Design
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                              Transversal Design
  23.                                 PO Box 66082
  24.                            Chicago, IL  60666-0082
  25.                       Beeper: (312) 999-0745 (digital)
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                                                                         071590
  35. First Things First:
  36.  
  37. Please take the time to read the License, Warranty and Registration
  38. information.  If you have received this file without printed documentation,
  39. this information is contained in the file named LICENSE.DOC.
  40.  
  41. The information contained in this file/pamphlet outlines copyright
  42. information, licensing agreement, warranty, technical support policies and
  43. additional information about registering your software.  It also includes
  44. descriptions of other programs by Transversal Design in which you might be
  45. interested.  Please take the time to read this information to be sure you
  46. understand your rights and the expectations/guidelines of Transversal Design.
  47. ZIPSORCE
  48.  
  49. ZipSorce came about one day while working on a program with over 45,000 lines
  50. of code in it.  It started getting very difficult to maintain an adequate
  51. backup of JUST the program code.  We wrote ZipSorce to step through a Pascal
  52. source file, determine which units it used and any include files, then create
  53. a batch file of these file names and shell out to PKZIP to make our backup. 
  54. We then added the ability to include non-source files in the zipping.
  55.  
  56. ZipSorce is intended to be used as a zipping/backup utility for Pascal
  57. programmers.  Future versions may include compatibility for C and assembly
  58. programmers.  We use it to maintain complete-version zip files for archive
  59. purposes, and also to create distribution files (see below).
  60.  
  61.  
  62.  
  63. Prior Knowledge/Limitations
  64.  
  65. It is assumed that the user is reasonably familiar with PKZIP and has a copy
  66. of it in their default path.  It is also assumed that this copy of PKZIP is a
  67. registered copy.  If you are using it, please register it.  Enough soap
  68. boxing.
  69.  
  70. Further assumptions are that the user is familiar with DOS, entering commands
  71. into the computer, and entering parameters on the command line for programs.
  72.  
  73. ZipSorce uses the heap for a lot of its manipulations.  It should run on any
  74. IBM or compatible.  It is assumed that the user has at least 512k, although
  75. this is not a requirement of the program.  The EXE file is about 20k, leaving
  76. the rest of memory for the manipulations and PKZIP.  Any computer which will
  77. run PKZIP should be able to run ZipSorce.
  78.  
  79. NOTE: ZipSorce has not been tested on any networks.  Feedback is desired (in
  80. writing please) from any users with access to networks.
  81.  
  82.  
  83.  
  84. Usage
  85.  
  86. For those users who are fairly familiar with command-line driven programs such
  87. as PKZIP, the usage should be fairly straight-forward.  The command line is:
  88.  
  89. ZIPSORCE sourcefilename [/T] [/H|/?] [/L] ["zip parms"] where:
  90.         sourcefilename      = file to process.
  91.         /H or /?            = show help only.
  92.         /T                  = include TPU files.
  93.         /L                  = show (log) files which will be processed.
  94.         ["zip parms"]       = parameters to pass to PKZIP.
  95.  
  96. ZipSorce is not case-sensitive.  The parameters may be entered in any order. 
  97. The quotes ( " ) must be included surrounding the parameters to pass to PKZIP. 
  98. The parameters are passed to PKZIP EXACTLY as entered, with no conversions
  99. other than to remove the quotes.
  100. /T may be used to force the inclusion of TPU files with the source code.  /L
  101. will show the files which would be included in the zipping without actually
  102. calling PKZIP.
  103.  
  104. All output may be redirected using standard DOS conventions.
  105.  
  106.  
  107.  
  108. What It Does:
  109.  
  110. ZipSorce will step through the specified source file line by line and make
  111. decisions regarding whether or not there is a file to be included.  All
  112. remarks within a file are ignored since the compiler would ignore them also. 
  113. Any USES directive will queue the file for inclusion, up to the terminating
  114. semi-colon (it does not have to be on the same line).  If the /T option is
  115. specified, the TPU file will be queued also.  Any files to be included with
  116. the {$I compiler directive will also be queued, without a corresponding TPU
  117. file.  A special comment, starting with {ZIPSOURCE INCLUDE: ....} will include
  118. any files held within the comment.
  119.  
  120. All files, other than those specified with ZIPSOURCE INCLUDE:, will be read
  121. after the source file is finished, and processed one at a time in the same
  122. fashion.  ZIPSOURCE INCLUDE: may also be used in these "sub-files".
  123.  
  124. After all files are processed, ZipSorce will determine where PKZIP is at on
  125. your drive, create the batch file to be used with the @ directive, then shell
  126. out to PKZIP to create the zip file.  The zip file will have the same name as
  127. the source file (with the extension of ZIP instead of PAS).
  128.  
  129. That's pretty much all there is to it.  One final note about processing...
  130. sometimes a TPU file will exist without a PAS file.  This may be because of a
  131. company distributing only compiled code (without source), or for other
  132. reasons.  ZipSorce will ALWAYS include the TPU file if the PAS unit is not
  133. found.
  134.  
  135.  
  136.  
  137. Of Interest:
  138.  
  139. It was mentioned earlier that we use ZipSorce for distribution files. 
  140. Specifically, we created two files before ZipSorce was uploaded, one was
  141. ZIPSORCE.SDT (for source data) and another called ZIPSORCE.DDT (for
  142. distributed data).  Both files were simply ZIPSORCE INCLUDE files.  You should
  143. have downloaded ZIPSORCE.DDT with this file.  Take a moment to look at it. 
  144. Although ZipSorce adds the .PAS extension to the source file if it is not
  145. entered, it will process any file if the extension is specified.
  146.  
  147. We created the distribution file with the following command:
  148.  
  149. ZIPSORCE ZIPSORCE.DDT       <Enter>
  150. After ZipSorce completed the zipping, we copied ZIPSORCE.ZIP to our upload
  151. directory, erased it, then made a backup of the source code with:
  152.  
  153. ZIPSORCE ZIPSORCE.SDT       <Enter>
  154.  
  155. A WORD OF CAUTION:  PKZIP will not overwrite zip files which exist, but will
  156. add or update to them.  This is good, it keeps you from losing zip files. 
  157. BUT, in the use of ZipSorce in the above example, since all of the data files
  158. (.DDT and .SDT) contain the same main file name, the zip file MUST be copied
  159. to another directory then erased to avoid including files which you had not
  160. intended.  In the above example, without this step, we would have
  161. inadvertently added source code to the distributed files.
  162.  
  163.  
  164. An example with parameters for PKZIP:
  165.  
  166. ZIPSORCE SOURCE.PAS /T "-m"
  167.  
  168. This would step through SOURCE.PAS, determine files to include, include the
  169. TPU files and call PKZIP to zip the files, then erase them from the drive (the
  170. -m move directive).
  171.  
  172. This should be sufficient documentation to get you started.  Please take the
  173. time to read the file LICENSE.DOC.  Happy Zipping!
  174. PKZIP is a registered trademark of PK Ware, Inc.  For more information
  175. regarding PKZIP, contact:
  176.         PK Ware, Inc.
  177.         7545 North Port Washington Road
  178.         Suite 205
  179.         Glendale, WI  53217
  180.         (414) 352-3670
  181.  
  182. The inclusion of these product names in this documentation is no indication
  183. whatsoever that the respective companies have used or endorse this product.
  184.  
  185.  
  186.          ----------------end-of-author's-documentation---------------
  187.  
  188.                          Software Library Information:
  189.  
  190.                     This disk copy provided as a service of
  191.  
  192.                            Public (software) Library
  193.  
  194.          We are not the authors of this program, nor are we associated
  195.          with the author in any way other than as a distributor of the
  196.          program in accordance with the author's terms of distribution.
  197.  
  198.          Please direct shareware payments and specific questions about
  199.          this program to the author of the program, whose name appears
  200.          elsewhere in  this documentation. If you have trouble getting
  201.          in touch with the author,  we will do whatever we can to help
  202.          you with your questions. All programs have been tested and do
  203.          run.  To report problems,  please use the form that is in the
  204.          file PROBLEM.DOC on many of our disks or in other written for-
  205.          mat with screen printouts, if possible.  PsL cannot debug pro-
  206.          programs over the telephone, though we can answer questions.
  207.  
  208.          Disks in the PsL are updated  monthly,  so if you did not get
  209.          this disk directly from the PsL, you should be aware that the
  210.          files in this set may no longer be the current versions. Also,
  211.          if you got this disk from another vendor and are having prob-
  212.          lems,  be aware that  some files may have become corrupted or
  213.          lost by that vendor. Get a current, working disk from PsL.
  214.  
  215.          For a copy of the latest monthly software library newsletter
  216.          and a list of the 2,000+ disks in the library, call or write
  217.  
  218.                            Public (software) Library
  219.                                P.O.Box 35705 - F
  220.                             Houston, TX 77235-5705
  221.  
  222.                                 1-800-2424-PSL
  223.                                  MC/Visa/AmEx
  224.  
  225.                           Outside of U.S. or in Texas
  226.                           or for general information,
  227.                               Call 1-713-524-6394
  228.  
  229.                           PsL also has an outstanding
  230.                           catalog for the Macintosh.
  231.  
  232.